home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1995 May / macformat-024.iso / Shareware City / HyperCard / MyLibMgr1.0-HC Folder / MyLibMgr 1.0 ReadMe next >
Encoding:
Text File  |  1995-01-17  |  12.9 KB  |  168 lines  |  [TEXT/MSWD]

  1.                                                    Welcome to MyLibMgr!!!
  2.  
  3. Introduction
  4. ------------
  5. This is my reference library managing stack.  I have spent many hours writing, fixing, adding to,
  6. optimizing, and using this stack.  I hope you find it as useful as I do.
  7.  
  8. Acknowledgements
  9. ----------------
  10. It is important to acknowledge the authorship of several XCMD/XFCN's.  Fullsort, Promptoid,
  11. ListSelect, FullHPopup, Fullfind, StripDup, ResText and FullReplace are from the excellent set by
  12. Fredric Rinaldi.  Buildmenu and BreakLine are my own, complied with the Demo version of
  13. CompileIt, the Hypertalk Compiler from Heizer Software.  This demo version limits scripts for
  14. compilation to 10 lines, but it is possible to accomplish a lot in 10 lines.  Based on the demo, I
  15. highly recommend the real thing (hopefully this acknowledgement and plug will satisfy Heizer
  16. for my distribution of these externals).  If only I could afford it...
  17.  
  18. Shareware Plea
  19. --------------
  20. I am a poor, chronic-type student (14 years of college has not be cheap).  Please send money.
  21. Send  $10 (or whatever you think it is worth and can afford) to help pay my tuition and
  22. encourage  further development (ie CompileIt).  My address is at the bottom of this field.  Become
  23. a  registered user and I will notify you (preferrably by Email) of future enhancements or fixes.
  24. I am also willing  (for registered users) to create custom import/export definitions.  Just send
  25. me a copy of what you want to import or export.  Support shareware!
  26.  
  27. Overview
  28. --------
  29. What does it do?   MLM is useful for reviewing and managing bibliographic references.  I use
  30. multiple copies (eg. MLM-Blank, MLM-Copied, MLM-Widgets) of this stack to (1) review
  31. references and abstracts downloaded via telnet (a separate stack for each downloaded set), and
  32. (2) to manage my file cabinet of photocopied articles and assist in putting together bibliography
  33. lists for papers. 
  34.  
  35. To review articles downloaded from Medline (a database of medical literature AKA paperchase),
  36. the stack has scripts  (1) for importing references in NLF (National Library Format), (2) for
  37. sorting references by author, source, or user defined categories, (3) for marking references
  38. manually or by several automatic methods, and (4) for printing and exporting marked
  39. references.  Usually, I import the references, sort by source, then menumark unimportant
  40. journals, delete that set of marked references, resort by author, review the references marking
  41. ones that I'm interested in photocopying, resort by source (because the library is arranged by
  42. journal name), and then print the marked references.  More details for each of these steps is 
  43. provided below.
  44.  
  45. To manage my file cabinet of photocopied articles, I keep the photocopies articles organized by
  46. the first author name and then maintain a parallel listing in a stack.  In this way, I can locate
  47. any article in my file cabinet by searching the stack for any part of the title, any of the authors,
  48. source, category, or keyword.  The stack has several features for manually or automatically
  49. adding references.  Additionally, the stack has two methods for creating or adding to a
  50. bibliography list for a paper.  The first (simple) option is to select a group of references and 
  51. export them to a text file to serve as a starting point for your reference list.  The second option 
  52. is for the stack to read an RTF formatted copy of the paper, locate the authors and reference 
  53. sites, and  offer references from the stack for inclusion in the bibliography.  More details are 
  54. provided below.
  55.  
  56. Cards
  57. -----
  58. The menu card is mostly a convenient way of indicating the first card in the stack.  It has only
  59. two special features over the rest of the cards, which are two fields which look nice, but provide
  60. less functionality than other options which are described below.  The first field is the sort menu,
  61. which can be accessed by using the SORT MENU button.  The second field is the scan menu, which
  62. can be accessed by using the SCAN MENU button.  The fields are filled and/or updated whenever 
  63. the stack is sorted or scanned.
  64.  
  65. The reference cards makes up the bulk of the stack (at least after some have been created).  Each 
  66. reference card has 7 fields and 10 buttons, and 4 popup menus. 
  67.  
  68. There are 7 fields on each card:  The TITLE, JOURNAL, and ABSTRACT FIELD are fairly self
  69. explanatory.  AUTHOR FIELD:  The author field is the list of authors, which should be a comma
  70. separated list (which implies that the author names cannot have commas within them).  CITATION
  71. FIELD:  Is for the citation information, the only assumption for the data in this field is that the 
  72. first 4 characters are the year.  The recommended format for is year;volume:pagenums, as in "1991;12(3):328-335".  While this format is not required, for the year sorting (see description of the sort/scan popup menu below) to perform properly, the first four characters of the citation must be the year.  For assisted input, there is a popup menu in the journal field (see below) which offers, if the fields are locked (see below), journal names (if the popup menu data has been collected - see below) and prompts for year, volume, and pages.  USER FIELD is for a category.  New categories can be created by typing them into the field.  Once categories have been created (and collected - see below) and if the fields are locked, the userfield can be assigned by a popup menu.  KEYWORD FIELD is for a list of keywords, which can either be those downloaded from Medline major headings, or specified by the user.  If the fields are locked, a popup menu can be used for entry.
  73.  
  74. There are 9 buttons along the bottom:  RETURN  returns the stack to the menu card.  NEXT, PREV,
  75. NEXT MARKED, PREV MARKED, and FEILD LOCK are self explanatory.  SORT MENU and SCAN MENU
  76. bring up a dialog menu of a sort or scan list of cards as created by the most recent sort and 
  77. scan operations.  Pressing the first letter of a desired entry jumps to that part of the menu.  
  78. GRAB BUTTON:  Places the authors, title, and source on the clipboard for pasting elsewhere, eg 
  79. into the bibliography of a paper.
  80.  
  81. There is one additional button in the upper right corner of the card (except on the menu card).
  82. Clicking this button is indicated by flipping the corner, ie. "dogear-ing the corner".  Multiple 
  83. cards can be marked and the set of marked cards becomes an important subset of cards which can 
  84. be manipulated (ie printed or exported) independently of the unmarked cards.  A field in the lower 
  85. left displays the total number of cards and the number of marked cards.  Several stack features 
  86. are designed for selecting, viewing, printing, deleting, and remembering sets of marked cards, 
  87. and are described below.
  88.  
  89. There are 4 popup menus (in addition to the 3 fields popup menus available when the text of the 
  90. fields are locked):
  91.  
  92. IMPORT/EXPORT MENU:  Offers several options for printing,  importing, exporting, and making
  93. bibliographies.  PRINT will print the references, with or without abstracts and keywords.
  94. IMPORT will read data from a text file.  The standard format is NLF (National Library Format)
  95. text file, but other formats can be defined using a custom format defined using import format
  96. option.  When the import format is selected, 3 fields and a popup menu are displayed.  The popup
  97. menu provides all of the elements for creating a new format, as well as options for storing,
  98. recalling, and deleting new formats.  Special options are described in the format information field
  99. at the bottom.  The middle field is for sample input text for testing the import format definition.
  100. It can be loaded from the file using a popup menu option.  Two formats have been defined as
  101. examples.  The default format reads:
  102.      1.  Waanders NA, Vander PA:  Title.  Journal, 1992;1:29-30. 
  103. The DBF format reads:
  104.      "Waanders, N.A.","Title","Journal","1992;1:29-30"," abstract","Keywords"
  105. For either NLF or custom formatted files, a new card is created for each reference in the file.  A
  106. named set of marked cards (see below for definition) is automatically created for each import
  107. operation with the date and time as the set name.  EXPORT will export to a text file in either
  108. custom or NLF format.  Like the import format definition, the export format is defined with 2
  109. fields and a popup menu.  The specification must be a valid hypercard expression combining the
  110. field names with chunk expression (eg. char 1 to 4 of line 1 of field "citation", which should be
  111. the year - if you follow the recommended, by no means required, citation field format).
  112. Additionally, there are several useful variables which are described in the export format
  113. information field.   There are 2 predefined formats to use as examples, and match the default and
  114. DBF formats described for the custom import format definition (described above).  BIBLIFY is my
  115. pride and joy and can be only fully appreciated by trying the sample files which can be created by
  116. the menu option 'create sample files'.  The files are: sample.nlf (a file with 2 references for
  117. importing) and sample.rtf (a sample reference paper in RTF format with 4 references, 2 already
  118. in the document, 1 of which relates to the document as a whole and is not directly referred to in
  119. the text).  First use the import button to import the two references from sample.nlf.  Then sort
  120. the stack by first author.  Then use the biblify button.  For each reference in the text, the author,
  121. the context for the reference, and a range of authors and titles from the stack are displayed.
  122. Select one reference from the list by double clicking or multiple references by holding the
  123. command key.  A new RTF file will be written called 'sample.rtf.bib'.  Open sample.rtf and
  124. sample.rtf.bib with your word processor to see the results.  Biblify will read a RTF formated
  125. text file, locate author references in the text, offer references from the stack by that author,
  126. and then generate a numbered alphabetized reference list and insert the appropriate numbers into
  127. the text.   The paper must be saved in an RTF text file (Rich Text Format - which should be an
  128. output option from most word processors).  The script first looks for the location of the current
  129. bibliography list, as indicated by a line with the single word "REFERENCES", followed by either
  130. (1) 2 same formatted blank lines, or (2) a sequentially numbered bibliography formatted
  131. 'num<tab>ref' with a same formatted blank line following.  References in the text should be in
  132. square brackets '[]' and include a comma separated list of authors or numbers (refering to
  133. references in the current bibliography list).
  134.  
  135. UTILITIES MENU:  Offers several diferent stack utility options.  CLIPREF:  This option is the same
  136. as the grab button and puts the current card's title and citation in the clipboard for pasting
  137. elsewhere.  DELETE offers 5 options for removing cards from the stack. The duplicate option will
  138. remove duplicates provided they are adjacent to each other in the stack (as accomplished by
  139. sorting).  POPUP COLLECT will build the journal, keyword, and user field popup menus by
  140. collecting all existing items in the selected field.  POPUP EDIT allows deletion of items from the
  141. menu.  Note that the fields must be locked to use the field popup menu.  FIND & REPLACE will
  142. locate all occurances of a target string, and replace each occurange with a replacement string.
  143. CLEANUP offers a few options for cleaning up fields.
  144.  
  145. SORT/SCAN MENU:  SORT rearranges the cards and creates a list of cards by first author,
  146. source, year, or keyword.  SCAN builds a list of authors or keywords, without reordering the
  147. cards.  Both the sort and scan lists are displayed on the menu card and in the sort menu and scan
  148. menu buttons.  EXPORT SORT writes a text file with a list of articles by title for each item in the sort menu.  This may be useful when you have multiple articles by each of multiple authors and need a list of artilces for each author.  EXPORT SCAN writes a text file with a list of articles my title or first-author and title for each item in the scan list.  This is useful when you need a list of  of the artilces an with that co-author or keyword.
  149.  
  150. MARKING MENU:  MARK and UNMARK are obvious.  MENUMARK displays either the sort or scan
  151. menu  and allows single, continuous (by holding the shift key), or discontinuous (by holding the
  152. command key) selections of items from a dialog box for card marking.  FINDMARK and
  153. FINDUNMARK will mark or unmark cards based on a keyword search in any or all the fields on
  154. each card.  STORE SETS saves the current list of marked cards as a card set with a user
  155. specified name.  RESTORE SETS will mark or unmark cards depending on the option selected, and
  156. provides a useful methods for combining lists.  DELETE SETS allows for destroying previously
  157. stored lists.
  158.  
  159. Bugs/Compliments/Suggestions
  160. ----------------------------
  161. If you find any bugs or run into things that don't seem to work the way they should, or think of
  162. features you would like added, please let me know by Email (waanders@umich.edu) or by US mail
  163. (1245 Island Drive #203, Ann Arbor, MI 48105).  I will do what I can to fix/add things. 
  164.  
  165. Nick Waanders
  166. Ann Arbor, Michigan
  167. November 18, 1994
  168.